Information about this user and what they've been awarded from this reward, and how this compares to others in their organisation
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| myEntries | List | Returns entries for the current user in this reward | |
| since | Date | ||
| to | Date | ||
| reward | Reward | ||
| requiredGroups | List | ||
| myPointsTotal | int | The total of all points earned by this user in this reward | |
| myPoints | List | Get all of the individual points records for this user which have been awarded since the given date, if not null | |
| myPointDebits | List | Get all of the individual point debit records for this user which have been issued since the given date, if not null | |
| pointsByReason | Map | ||
| myPercent | long | What percentage are my points of points earned for this reward in my organisation | |
| teamMemberPoints | List | Get an ordered list of the top points earners for my team since the given date | |
| allMemberPoints | List | Get a leaderboard of all users, not just in the user's organiastion, but everyone connected to the reward | |
| myRank | RankAndPoints | ||
| summedPointsByProfile | List | ||
| teamPointsRaw | List | ||
| mostPoints | Long | The greatest number of points earned by someone in my organisation for this reward | |
| totalTeamPoints | Long | ||
| teamName | String | The name of my organisation relevant to this reward |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| allMemberPoints ( tagname ) | List | Get a leaderboard of points filtered by the given tag name. OR use the special value "none" (not case sensitive) to filter for records which have no points tag | |
| rank ( p ) | RankAndPoints | Get the rank and points information for the given profile in the entire reward | |
| rankInTeam ( p ) | RankAndPoints | ||
| addRequiredGroup ( groupName ) | void | Add a required group. Only members in all required groups will be included in results from teamMemberPoints |
Ask a question, or offer an answer